<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>v_frmbuf_rd: XV_FrmbufRd_l2 Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">v_frmbuf_rd
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li class="current"><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('struct_x_v___frmbuf_rd__l2.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#pub-attribs">Data Fields</a>  </div>
  <div class="headertitle">
<div class="title">XV_FrmbufRd_l2 Struct Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Frame Buffer Read driver Layer 2 data.  
 <a href="struct_x_v___frmbuf_rd__l2.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:a0ae31af8998fd7d5456807e3397602ca"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_x_v__frmbufrd.html">XV_frmbufrd</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_v___frmbuf_rd__l2.html#a0ae31af8998fd7d5456807e3397602ca">FrmbufRd</a></td></tr>
<tr class="memdesc:a0ae31af8998fd7d5456807e3397602ca"><td class="mdescLeft">&#160;</td><td class="mdescRight">Frame Buffer Read instance data.  <a href="#a0ae31af8998fd7d5456807e3397602ca">More...</a><br/></td></tr>
<tr class="separator:a0ae31af8998fd7d5456807e3397602ca"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a89bc60bff119d8099d26f5e5fa6bebfa"><td class="memItemLeft" align="right" valign="top"><a class="el" href="xv__frmbufrd__l2_8h.html#af768bed50faa73ab2b391458998ec4ce">XVFrmbufRd_Callback</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_v___frmbuf_rd__l2.html#a89bc60bff119d8099d26f5e5fa6bebfa">FrameDoneCallback</a></td></tr>
<tr class="memdesc:a89bc60bff119d8099d26f5e5fa6bebfa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Callback for frame processing done.  <a href="#a89bc60bff119d8099d26f5e5fa6bebfa">More...</a><br/></td></tr>
<tr class="separator:a89bc60bff119d8099d26f5e5fa6bebfa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af5197034b172783210b2cb88547bfa87"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_v___frmbuf_rd__l2.html#af5197034b172783210b2cb88547bfa87">CallbackDoneRef</a></td></tr>
<tr class="memdesc:af5197034b172783210b2cb88547bfa87"><td class="mdescLeft">&#160;</td><td class="mdescRight">To be passed to the connect interrupt callback.  <a href="#af5197034b172783210b2cb88547bfa87">More...</a><br/></td></tr>
<tr class="separator:af5197034b172783210b2cb88547bfa87"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a48f7a71fe84c44380cc6c1d253e0fa67"><td class="memItemLeft" align="right" valign="top"><a class="el" href="xv__frmbufrd__l2_8h.html#af768bed50faa73ab2b391458998ec4ce">XVFrmbufRd_Callback</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_v___frmbuf_rd__l2.html#a48f7a71fe84c44380cc6c1d253e0fa67">FrameReadyCallback</a></td></tr>
<tr class="memdesc:a48f7a71fe84c44380cc6c1d253e0fa67"><td class="mdescLeft">&#160;</td><td class="mdescRight">Callback for frame processing ready.  <a href="#a48f7a71fe84c44380cc6c1d253e0fa67">More...</a><br/></td></tr>
<tr class="separator:a48f7a71fe84c44380cc6c1d253e0fa67"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aff68a0427bdc269ca05fde57f7cc8743"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_v___frmbuf_rd__l2.html#aff68a0427bdc269ca05fde57f7cc8743">CallbackReadyRef</a></td></tr>
<tr class="memdesc:aff68a0427bdc269ca05fde57f7cc8743"><td class="mdescLeft">&#160;</td><td class="mdescRight"><pre class="fragment">To be passed to the connect interrupt
</pre><p> callback  <a href="#aff68a0427bdc269ca05fde57f7cc8743">More...</a><br/></td></tr>
<tr class="separator:aff68a0427bdc269ca05fde57f7cc8743"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ada8c009caccb985b0e3410c572852b73"><td class="memItemLeft" align="right" valign="top">XVidC_VideoStream&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_v___frmbuf_rd__l2.html#ada8c009caccb985b0e3410c572852b73">Stream</a></td></tr>
<tr class="memdesc:ada8c009caccb985b0e3410c572852b73"><td class="mdescLeft">&#160;</td><td class="mdescRight">Output AXIS.  <a href="#ada8c009caccb985b0e3410c572852b73">More...</a><br/></td></tr>
<tr class="separator:ada8c009caccb985b0e3410c572852b73"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Frame Buffer Read driver Layer 2 data. </p>
<p>The user is required to allocate a variable of this type for every frame buffer read device in the system. A pointer to a variable of this type is then passed to the driver API functions. </p>
</div><h2 class="groupheader">Field Documentation</h2>
<a class="anchor" id="af5197034b172783210b2cb88547bfa87"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void* XV_FrmbufRd_l2::CallbackDoneRef</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>To be passed to the connect interrupt callback. </p>

<p>Referenced by <a class="el" href="group__v__frmbuf__rd.html#gab2c3dd4bfc1f4acf08353543704c836b">XVFrmbufRd_InterruptHandler()</a>, and <a class="el" href="group__v__frmbuf__rd.html#ga90785baf366d034a2e602ec6cd5a9dff">XVFrmbufRd_SetCallback()</a>.</p>

</div>
</div>
<a class="anchor" id="aff68a0427bdc269ca05fde57f7cc8743"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void* XV_FrmbufRd_l2::CallbackReadyRef</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><pre class="fragment">To be passed to the connect interrupt
</pre><p> callback </p>

<p>Referenced by <a class="el" href="group__v__frmbuf__rd.html#gab2c3dd4bfc1f4acf08353543704c836b">XVFrmbufRd_InterruptHandler()</a>, and <a class="el" href="group__v__frmbuf__rd.html#ga90785baf366d034a2e602ec6cd5a9dff">XVFrmbufRd_SetCallback()</a>.</p>

</div>
</div>
<a class="anchor" id="a89bc60bff119d8099d26f5e5fa6bebfa"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="xv__frmbufrd__l2_8h.html#af768bed50faa73ab2b391458998ec4ce">XVFrmbufRd_Callback</a> XV_FrmbufRd_l2::FrameDoneCallback</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Callback for frame processing done. </p>

<p>Referenced by <a class="el" href="group__v__frmbuf__rd.html#gab2c3dd4bfc1f4acf08353543704c836b">XVFrmbufRd_InterruptHandler()</a>, and <a class="el" href="group__v__frmbuf__rd.html#ga90785baf366d034a2e602ec6cd5a9dff">XVFrmbufRd_SetCallback()</a>.</p>

</div>
</div>
<a class="anchor" id="a48f7a71fe84c44380cc6c1d253e0fa67"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="xv__frmbufrd__l2_8h.html#af768bed50faa73ab2b391458998ec4ce">XVFrmbufRd_Callback</a> XV_FrmbufRd_l2::FrameReadyCallback</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Callback for frame processing ready. </p>

<p>Referenced by <a class="el" href="group__v__frmbuf__rd.html#gab2c3dd4bfc1f4acf08353543704c836b">XVFrmbufRd_InterruptHandler()</a>, and <a class="el" href="group__v__frmbuf__rd.html#ga90785baf366d034a2e602ec6cd5a9dff">XVFrmbufRd_SetCallback()</a>.</p>

</div>
</div>
<a class="anchor" id="a0ae31af8998fd7d5456807e3397602ca"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="struct_x_v__frmbufrd.html">XV_frmbufrd</a> XV_FrmbufRd_l2::FrmbufRd</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Frame Buffer Read instance data. </p>

<p>Referenced by <a class="el" href="group__v__frmbuf__rd.html#ga80af786a199e9d406016cbe77c6cce9a">XVFrmbufRd_DbgReportStatus()</a>, <a class="el" href="group__v__frmbuf__rd.html#ga4a2a50eb3122b05363529db59acaa699">XVFrmbufRd_Get_FidErrorCount()</a>, <a class="el" href="group__v__frmbuf__rd.html#gaa7f04dec0da407195c91e99252ba2f4d">XVFrmbufRd_Get_FidErrorOut()</a>, <a class="el" href="group__v__frmbuf__rd.html#ga332ca9116cadeb32b1904ce3dde65abc">XVFrmbufRd_Get_FidOutMode()</a>, <a class="el" href="group__v__frmbuf__rd.html#gaa3a66d4846e2dc24fef32aa98ac9806c">XVFrmbufRd_Get_FieldOut()</a>, <a class="el" href="group__v__frmbuf__rd.html#gaeac91da19a88ff2480eae16be554b1f2">XVFrmbufRd_GetBufferAddr()</a>, <a class="el" href="group__v__frmbuf__rd.html#ga7475f43a7f18a159c1714849fe170c3b">XVFrmbufRd_GetChromaBufferAddr()</a>, <a class="el" href="group__v__frmbuf__rd.html#gaf6aab33970a5d93caf764bddea2c86c4">XVFrmbufRd_GetFieldID()</a>, <a class="el" href="group__v__frmbuf__rd.html#gacca36af12be280cd3cc168feb0a28bd4">XVFrmbufRd_GetVChromaBufferAddr()</a>, <a class="el" href="group__v__frmbuf__rd.html#gaed42e419ae477b01e8677cabe9d07edc">XVFrmbufRd_Initialize()</a>, <a class="el" href="group__v__frmbuf__rd.html#ga0faa399949f921d9a32ceb8321de756e">XVFrmbufRd_InterruptDisable()</a>, <a class="el" href="group__v__frmbuf__rd.html#ga95f8a0ce5448dc0b3adcaed0365aacfb">XVFrmbufRd_InterruptEnable()</a>, <a class="el" href="group__v__frmbuf__rd.html#gab2c3dd4bfc1f4acf08353543704c836b">XVFrmbufRd_InterruptHandler()</a>, <a class="el" href="group__v__frmbuf__rd.html#ga2b93653c8567e7735888fe5e8c76aabf">XVFrmbufRd_Set_FidOutMode()</a>, <a class="el" href="group__v__frmbuf__rd.html#gab166d212d55646b832a8f7c301e5f2ac">XVFrmbufRd_SetBufferAddr()</a>, <a class="el" href="group__v__frmbuf__rd.html#ga395f9c364ef8378189bf0464d2130d59">XVFrmbufRd_SetChromaBufferAddr()</a>, <a class="el" href="group__v__frmbuf__rd.html#ga76d715c4caace0c73116230fb3b51a66">XVFrmbufRd_SetFieldID()</a>, <a class="el" href="group__v__frmbuf__rd.html#ga8d3a4c93e59a529e936c21169f738202">XVFrmbufRd_SetMemFormat()</a>, <a class="el" href="group__v__frmbuf__rd.html#ga84c9a6e2049cb53358884cd8e3aafbc2">XVFrmbufRd_SetVChromaBufferAddr()</a>, <a class="el" href="group__v__frmbuf__rd.html#ga0e9f4473b9679d84441160c08b461d9b">XVFrmbufRd_Start()</a>, <a class="el" href="group__v__frmbuf__rd.html#gaf95f5597208997861ca3b2de238821e1">XVFrmbufRd_Stop()</a>, and <a class="el" href="group__v__frmbuf__rd.html#ga05848286286c2df893b2ef8195167e47">XVFrmbufRd_WaitForIdle()</a>.</p>

</div>
</div>
<a class="anchor" id="ada8c009caccb985b0e3410c572852b73"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">XVidC_VideoStream XV_FrmbufRd_l2::Stream</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Output AXIS. </p>

<p>Referenced by <a class="el" href="group__v__frmbuf__rd.html#gafa85f47f05af0d3353f3cdcadbb29a1c">XVFrmbufRd_GetVideoStream()</a>, and <a class="el" href="group__v__frmbuf__rd.html#ga8d3a4c93e59a529e936c21169f738202">XVFrmbufRd_SetMemFormat()</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
